<!DOCTYPE HTML><html><head><title>Placement Driver Core API API documentation</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="https://github.com/raml2html/raml2html 7.5.0"><link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"><script type="text/javascript" src="https://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script><script type="text/javascript">
      $(document).ready(function() {
  $('.page-header pre code, .top-resource-description pre code, .modal-body pre code').each(function(i, block) {
    hljs.highlightBlock(block);
  });

  $('[data-toggle]').click(function() {
    var selector = $(this).data('target') + ' pre code';
    $(selector).each(function(i, block) {
      hljs.highlightBlock(block);
    });
  });

  // open modal on hashes like #_action_get
  $(window).bind('hashchange', function(e) {
    var anchor_id = document.location.hash.substr(1); //strip #
    var element = $('#' + anchor_id);

    // do we have such element + is it a modal?  --> show it
    if (element.length && element.hasClass('modal')) {
      element.modal('show');
    }
  });

  // execute hashchange on first page load
  $(window).trigger('hashchange');

  // remove url fragment on modal hide
  $('.modal').on('hidden.bs.modal', function() {
    try {
      if (history && history.replaceState) {
          history.replaceState({}, '', '#');
      }
    } catch(e) {}
  });
});
    </script><style>
      .hljs {
  background: transparent;
}
.parent {
  color: #999;
}
.list-group-item > .badge {
  float: none;
  margin-right: 6px;
}
.panel-title > .methods {
  float: right;
}
.badge {
  border-radius: 0;
  text-transform: uppercase;
  width: 70px;
  font-weight: normal;
  color: #f3f3f6;
  line-height: normal;
}
.badge_get {
  background-color: #63a8e2;
}
.badge_post {
  background-color: #6cbd7d;
}
.badge_put {
  background-color: #22bac4;
}
.badge_delete {
  background-color: #d26460;
}
.badge_patch {
  background-color: #ccc444;
}
.list-group,
.panel-group {
  margin-bottom: 0;
}
.panel-group .panel+.panel-white {
  margin-top: 0;
}
.panel-group .panel-white {
  border-bottom: 1px solid #F5F5F5;
  border-radius: 0;
}
.panel-white:last-child {
  border-bottom-color: white;
  -webkit-box-shadow: none;
  box-shadow: none;
}
.panel-white .panel-heading {
  background: white;
}
.tab-pane ul {
  padding-left: 2em;
}
.tab-pane h1 {
  font-size: 1.3em;
}
.tab-pane h2 {
  font-size: 1.2em;
  padding-bottom: 4px;
  border-bottom: 1px solid #ddd;
}
.tab-pane h3 {
  font-size: 1.1em;
}
.tab-content {
  border-left: 1px solid #ddd;
  border-right: 1px solid #ddd;
  border-bottom: 1px solid #ddd;
  padding: 10px;
}
#sidebar {
  margin-top: 30px;
  padding-right: 5px;
  overflow: auto;
  height: 90%;
}
.top-resource-description {
  border-bottom: 1px solid #ddd;
  background: #fcfcfc;
  padding: 15px 15px 0 15px;
  margin: -15px -15px 10px -15px;
}
.resource-description {
  border-bottom: 1px solid #fcfcfc;
  background: #fcfcfc;
  padding: 15px 15px 0 15px;
  margin: -15px -15px 10px -15px;
}
.resource-description p:last-child {
  margin: 0;
}
.list-group .badge {
  float: left;
}
.method_description {
  margin-left: 85px;
}
.method_description p:last-child {
  margin: 0;
}
.list-group-item {
  cursor: pointer;
}
.list-group-item:hover {
  background-color: #f5f5f5;
}
pre code {
  overflow: auto;
  word-wrap: normal;
  white-space: pre;
}
.items {
  background: #f5f5f5;
  color: #333;
  border: 1px solid #ccc;
  border-radius: 4px;
  padding: 9.5px;
  margin: 0 0 10px;
  font-size: 13px;
  line-height: 1.42857143;
}
.examples {
  margin-left: 0.5em;
}
.resource-modal li > ul {
  margin-bottom: 1em;
}
.required {
  color: #f00;
}
    </style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>Placement Driver Core API API documentation <small>version v1</small></h1><p>http://{pdAddr}/pd/api/{version}</p><ul><li><strong>pdAddr</strong>: <em><span class="required">required</span>(string)</em><p>The PD server address, formatted as &#39;host:port&#39;.</p></li><li><strong>version</strong>: <em><span class="required">required</span>(v1)</em></li></ul></div><div class="panel panel-default"><div class="panel-heading"><h3 id="cluster_status" class="panel-title">/cluster/status</h3></div><div class="panel-body"><div class="top-resource-description"><p>Cluster status.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_cluster_status"><span class="parent"></span>/cluster/status</a> <span class="methods"><a href="#cluster_status_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_cluster_status" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#cluster_status_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get cluster status.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="cluster_status_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/cluster/status</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get cluster status.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#cluster_status_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="cluster_status_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>raft_bootstrap_time</strong>: <em>(string)</em></li><li><strong>is_initialized</strong>: <em><span class="required">required</span>(boolean)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="version" class="panel-title">/version</h3></div><div class="panel-body"><div class="top-resource-description"><p>The version of PD server.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_version"><span class="parent"></span>/version</a> <span class="methods"><a href="#version_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_version" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#version_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the version of PD server.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="version_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/version</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the version of PD server.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#version_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="version_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>version</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="status" class="panel-title">/status</h3></div><div class="panel-body"><div class="top-resource-description"><p>The build info of PD server.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_status"><span class="parent"></span>/status</a> <span class="methods"><a href="#status_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_status" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#status_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the build info of PD server.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="status_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/status</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the build info of PD server.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#status_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="status_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>build_ts</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>git_hash</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="diagnose" class="panel-title">/diagnose</h3></div><div class="panel-body"><div class="top-resource-description"><p>Diagnostic information of the cluster.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_diagnose"><span class="parent"></span>/diagnose</a> <span class="methods"><a href="#diagnose_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_diagnose" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#diagnose_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="diagnose_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/diagnose</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#diagnose_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="diagnose_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of object</p><p><strong>Items</strong>: DiagnoseRecommendation</p><div class="items"><ul><li><strong>module</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>level</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>description</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>instruction</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="members" class="panel-title">/members</h3></div><div class="panel-body"><div class="top-resource-description"><p>The PD servers in the cluster.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_members"><span class="parent"></span>/members</a> <span class="methods"><a href="#members_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_members" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#members_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List all PD servers in the cluster.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="members_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/members</h4></div><div class="modal-body"><div class="alert alert-info"><p>List all PD servers in the cluster.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#members_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="members_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>members</strong>: <em>(array of Member)</em><p><strong>Items</strong>: Member</p><div class="items"><ul><li><strong>name</strong>: <em>(string)</em></li><li><strong>member_id</strong>: <em>(integer)</em></li><li><strong>peer_urls</strong>: <em>(array of string)</em></li><li><strong>client_urls</strong>: <em>(array of string)</em></li><li><strong>leader_priority</strong>: <em>(integer)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>name</strong>: <em>(string)</em></li><li><strong>member_id</strong>: <em>(integer)</em></li><li><strong>peer_urls</strong>: <em>(array of string)</em></li><li><strong>client_urls</strong>: <em>(array of string)</em></li><li><strong>leader_priority</strong>: <em>(integer)</em></li></ul></li><li><strong>etcd_leader</strong>: <em>(object)</em><ul><li><strong>name</strong>: <em>(string)</em></li><li><strong>member_id</strong>: <em>(integer)</em></li><li><strong>peer_urls</strong>: <em>(array of string)</em></li><li><strong>client_urls</strong>: <em>(array of string)</em></li><li><strong>leader_priority</strong>: <em>(integer)</em></li></ul></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_members_name__name_"><span class="parent">/members</span>/name/{name}</a> <span class="methods"><a href="#members_name__name__delete"><span class="badge badge_delete">delete</span></a> <a href="#members_name__name__post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_members_name__name_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A specific PD server.</p></div><div class="list-group"><div onclick="window.location.href = '#members_name__name__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Remove a PD server from the cluster.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#members_name__name__post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Set leader priority of a PD member.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="members_name__name__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/members</span>/name/{name}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Remove a PD server from the cluster.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#members_name__name__delete_request" data-toggle="tab">Request</a></li><li><a href="#members_name__name__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="members_name__name__delete_request"><h3>URI Parameters</h3><ul><li><strong>name</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="members_name__name__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The PD server is successfully removed.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><p>The member does not exist.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="members_name__name__post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/members</span>/name/{name}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Set leader priority of a PD member.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#members_name__name__post_request" data-toggle="tab">Request</a></li><li><a href="#members_name__name__post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="members_name__name__post_request"><h3>URI Parameters</h3><ul><li><strong>name</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>leader-priority</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div><div class="tab-pane" id="members_name__name__post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The leader priority is updated.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><p>The member does not exist.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_members_id__id_"><span class="parent">/members</span>/id/{id}</a> <span class="methods"><a href="#members_id__id__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_members_id__id_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A specific PD server.</p></div><div class="list-group"><div onclick="window.location.href = '#members_id__id__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Remove a PD server from the cluster.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="members_id__id__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/members</span>/id/{id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Remove a PD server from the cluster.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#members_id__id__delete_request" data-toggle="tab">Request</a></li><li><a href="#members_id__id__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="members_id__id__delete_request"><h3>URI Parameters</h3><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div><div class="tab-pane" id="members_id__id__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The PD server is successfully removed.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="leader" class="panel-title">/leader</h3></div><div class="panel-body"><div class="top-resource-description"><p>The leader PD server of the cluster.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_leader"><span class="parent"></span>/leader</a> <span class="methods"><a href="#leader_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_leader" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#leader_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the leader PD server of the cluster.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="leader_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/leader</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the leader PD server of the cluster.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#leader_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="leader_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>name</strong>: <em>(string)</em></li><li><strong>member_id</strong>: <em>(integer)</em></li><li><strong>peer_urls</strong>: <em>(array of string)</em></li><li><strong>client_urls</strong>: <em>(array of string)</em></li><li><strong>leader_priority</strong>: <em>(integer)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_leader_resign"><span class="parent">/leader</span>/resign</a> <span class="methods"><a href="#leader_resign_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_leader_resign" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#leader_resign_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Transfer leadership to another PD server.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="leader_resign_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/leader</span>/resign</h4></div><div class="modal-body"><div class="alert alert-info"><p>Transfer leadership to another PD server.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#leader_resign_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="leader_resign_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The transfer command is submitted.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_leader_transfer__nextleader_"><span class="parent">/leader</span>/transfer/{nextLeader}</a> <span class="methods"><a href="#leader_transfer__nextleader__post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_leader_transfer__nextleader_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#leader_transfer__nextleader__post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Transfer leadership to the specific PD server.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="leader_transfer__nextleader__post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/leader</span>/transfer/{nextLeader}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Transfer leadership to the specific PD server.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#leader_transfer__nextleader__post_request" data-toggle="tab">Request</a></li><li><a href="#leader_transfer__nextleader__post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="leader_transfer__nextleader__post_request"><h3>URI Parameters</h3><ul><li><strong>nextLeader</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="leader_transfer__nextleader__post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The transfer command is submitted.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="health" class="panel-title">/health</h3></div><div class="panel-body"><div class="top-resource-description"><p>Health status of PD servers.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_health"><span class="parent"></span>/health</a> <span class="methods"><a href="#health_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_health" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#health_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="health_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/health</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#health_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="health_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of object</p><p><strong>Items</strong>: MemberHealth</p><div class="items"><ul><li><strong>name</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>member_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>client_urls</strong>: <em><span class="required">required</span>(array of string)</em></li><li><strong>health</strong>: <em><span class="required">required</span>(boolean)</em></li></ul></div><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="ping" class="panel-title">/ping</h3></div><div class="panel-body"><div class="top-resource-description"><p>Reply an empty response to the GET reqeust.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_ping"><span class="parent"></span>/ping</a> <span class="methods"><a href="#ping_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_ping" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#ping_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="ping_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/ping</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#ping_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="ping_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The server is listening.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="config" class="panel-title">/config</h3></div><div class="panel-body"><div class="top-resource-description"><p>PD cluster configuration.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_config"><span class="parent"></span>/config</a> <span class="methods"><a href="#config_get"><span class="badge badge_get">get</span></a> <a href="#config_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_config" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#config_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get full config.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#config_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Update a config item.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/config</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get full config.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/config</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update a config item.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_post_request" data-toggle="tab">Request</a></li><li><a href="#config_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="config_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The config is updated.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_config_schedule"><span class="parent">/config</span>/schedule</a> <span class="methods"><a href="#config_schedule_get"><span class="badge badge_get">get</span></a> <a href="#config_schedule_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_config_schedule" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Schedule configuration.</p></div><div class="list-group"><div onclick="window.location.href = '#config_schedule_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get schedule config.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#config_schedule_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Update a schedule config item.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_schedule_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/config</span>/schedule</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get schedule config.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_schedule_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_schedule_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>max-snapshot-count</strong>: <em>(integer)</em></li><li><strong>max-pending-peer-count</strong>: <em>(integer)</em></li><li><strong>max-merge-region-size</strong>: <em>(integer)</em></li><li><strong>max-merge-region-keys</strong>: <em>(integer)</em></li><li><strong>split-merge-interval</strong>: <em>(string)</em></li><li><strong>enable-one-way-merge</strong>: <em>(boolean)</em></li><li><strong>patrol-region-interval</strong>: <em>(string)</em></li><li><strong>max-store-down-time</strong>: <em>(string)</em></li><li><strong>leader-schedule-limit</strong>: <em>(integer)</em></li><li><strong>region-schedule-limit</strong>: <em>(integer)</em></li><li><strong>replica-schedule-limit</strong>: <em>(integer)</em></li><li><strong>merge-schedule-limit</strong>: <em>(integer)</em></li><li><strong>hot-region-schedule-limit</strong>: <em>(integer)</em></li><li><strong>hot-region-cache-hits-threshold</strong>: <em>(integer)</em></li><li><strong>store-balance-rate</strong>: <em>(number)</em></li><li><strong>tolerant-size-ratio</strong>: <em>(number)</em></li><li><strong>low-space-ratio</strong>: <em>(number)</em></li><li><strong>high-space-ratio</strong>: <em>(number)</em></li><li><strong>scheduler-max-waiting-operator</strong>: <em>(integer)</em></li><li><strong>enable-remove-down-replica</strong>: <em>(boolean)</em></li><li><strong>enable-replace-offline-replica</strong>: <em>(boolean)</em></li><li><strong>enable-make-up-replica</strong>: <em>(boolean)</em></li><li><strong>enable-remove-extra-replica</strong>: <em>(boolean)</em></li><li><strong>enable-location-replacement</strong>: <em>(boolean)</em></li><li><strong>schedulers-v2</strong>: <em>(object)</em><ul></ul></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_schedule_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/config</span>/schedule</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update a schedule config item.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_schedule_post_request" data-toggle="tab">Request</a></li><li><a href="#config_schedule_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_schedule_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="config_schedule_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The config is updated.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_config_replicate"><span class="parent">/config</span>/replicate</a> <span class="methods"><a href="#config_replicate_get"><span class="badge badge_get">get</span></a> <a href="#config_replicate_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_config_replicate" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Replication configuration.</p></div><div class="list-group"><div onclick="window.location.href = '#config_replicate_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get replication config.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#config_replicate_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Update a replication config item.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_replicate_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/config</span>/replicate</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get replication config.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_replicate_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_replicate_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>max-replicas</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>location-labels</strong>: <em><span class="required">required</span>(array of string)</em></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_replicate_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/config</span>/replicate</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update a replication config item.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_replicate_post_request" data-toggle="tab">Request</a></li><li><a href="#config_replicate_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_replicate_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="config_replicate_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The config is updated.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_config_label_property"><span class="parent">/config</span>/label-property</a> <span class="methods"><a href="#config_label_property_get"><span class="badge badge_get">get</span></a> <a href="#config_label_property_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_config_label_property" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>The label property configuration.</p></div><div class="list-group"><div onclick="window.location.href = '#config_label_property_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get label property config.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#config_label_property_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Update label property config item.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_label_property_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/config</span>/label-property</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get label property config.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_label_property_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_label_property_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_label_property_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/config</span>/label-property</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update label property config item.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_label_property_post_request" data-toggle="tab">Request</a></li><li><a href="#config_label_property_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_label_property_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>action</strong>: <em><span class="required">required</span>(one of set, delete)</em></li><li><strong>type</strong>: <em><span class="required">required</span>(reject-leader)</em></li><li><strong>label-key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>label-value</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="config_label_property_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The config is updated.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_config_rules"><span class="parent">/config</span>/rules</a> <span class="methods"><a href="#config_rules_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_config_rules" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Placement rules.</p></div><div class="list-group"><div onclick="window.location.href = '#config_rules_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get all placement rules.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_rules_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/config</span>/rules</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get all placement rules.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_rules_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_rules_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of object</p><p><strong>Items</strong>: Rule</p><div class="items"><ul><li><strong>group_id</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>id</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>index</strong>: <em>(integer)</em></li><li><strong>override</strong>: <em>(boolean)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>role</strong>: <em><span class="required">required</span>(one of voter, leader, follower, learner)</em></li><li><strong>count</strong>: <em><span class="required">required</span>(integer - minimum: 1)</em></li><li><strong>label_constraints</strong>: <em><span class="required">required</span>(array of LabelConstraint)</em><p><strong>Items</strong>: LabelConstraint</p><div class="items"><ul><li><strong>key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>op</strong>: <em><span class="required">required</span>(one of in, notIn, exists, notExists)</em></li><li><strong>values</strong>: <em>(array of string)</em></li></ul></div></li><li><strong>location_labels</strong>: <em><span class="required">required</span>(array of string)</em></li></ul></div><h2>HTTP status code <a href="http://httpstatus.es/412" target="_blank">412</a></h2><p>Placement rules feature is not enabled.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_config_rules_group__group_"><span class="parent">/config</span>/rules/group/{group}</a> <span class="methods"><a href="#config_rules_group__group__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_config_rules_group__group_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Placement rules of a group.</p></div><div class="list-group"><div onclick="window.location.href = '#config_rules_group__group__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get placement rules of a group.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_rules_group__group__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/config</span>/rules/group/{group}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get placement rules of a group.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_rules_group__group__get_request" data-toggle="tab">Request</a></li><li><a href="#config_rules_group__group__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_rules_group__group__get_request"><h3>URI Parameters</h3><ul><li><strong>group</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="config_rules_group__group__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of object</p><p><strong>Items</strong>: Rule</p><div class="items"><ul><li><strong>group_id</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>id</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>index</strong>: <em>(integer)</em></li><li><strong>override</strong>: <em>(boolean)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>role</strong>: <em><span class="required">required</span>(one of voter, leader, follower, learner)</em></li><li><strong>count</strong>: <em><span class="required">required</span>(integer - minimum: 1)</em></li><li><strong>label_constraints</strong>: <em><span class="required">required</span>(array of LabelConstraint)</em><p><strong>Items</strong>: LabelConstraint</p><div class="items"><ul><li><strong>key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>op</strong>: <em><span class="required">required</span>(one of in, notIn, exists, notExists)</em></li><li><strong>values</strong>: <em>(array of string)</em></li></ul></div></li><li><strong>location_labels</strong>: <em><span class="required">required</span>(array of string)</em></li></ul></div><h2>HTTP status code <a href="http://httpstatus.es/412" target="_blank">412</a></h2><p>Placement rules feature is not enabled.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_config_rules_region__region_"><span class="parent">/config</span>/rules/region/{region}</a> <span class="methods"><a href="#config_rules_region__region__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_config_rules_region__region_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Placement rules matched by a region.</p></div><div class="list-group"><div onclick="window.location.href = '#config_rules_region__region__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get placement rules matched by a region.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_rules_region__region__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/config</span>/rules/region/{region}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get placement rules matched by a region.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_rules_region__region__get_request" data-toggle="tab">Request</a></li><li><a href="#config_rules_region__region__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_rules_region__region__get_request"><h3>URI Parameters</h3><ul><li><strong>region</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div><div class="tab-pane" id="config_rules_region__region__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of object</p><p><strong>Items</strong>: Rule</p><div class="items"><ul><li><strong>group_id</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>id</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>index</strong>: <em>(integer)</em></li><li><strong>override</strong>: <em>(boolean)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>role</strong>: <em><span class="required">required</span>(one of voter, leader, follower, learner)</em></li><li><strong>count</strong>: <em><span class="required">required</span>(integer - minimum: 1)</em></li><li><strong>label_constraints</strong>: <em><span class="required">required</span>(array of LabelConstraint)</em><p><strong>Items</strong>: LabelConstraint</p><div class="items"><ul><li><strong>key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>op</strong>: <em><span class="required">required</span>(one of in, notIn, exists, notExists)</em></li><li><strong>values</strong>: <em>(array of string)</em></li></ul></div></li><li><strong>location_labels</strong>: <em><span class="required">required</span>(array of string)</em></li></ul></div><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The region ID is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><p>The region is not found.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_config_rules_key__key_"><span class="parent">/config</span>/rules/key/{key}</a> <span class="methods"><a href="#config_rules_key__key__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_config_rules_key__key_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Placement rules matched by a key.</p></div><div class="list-group"><div onclick="window.location.href = '#config_rules_key__key__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get placement rules matched by a key.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_rules_key__key__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/config</span>/rules/key/{key}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get placement rules matched by a key.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_rules_key__key__get_request" data-toggle="tab">Request</a></li><li><a href="#config_rules_key__key__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_rules_key__key__get_request"><h3>URI Parameters</h3><ul><li><strong>key</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="config_rules_key__key__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of object</p><p><strong>Items</strong>: Rule</p><div class="items"><ul><li><strong>group_id</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>id</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>index</strong>: <em>(integer)</em></li><li><strong>override</strong>: <em>(boolean)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>role</strong>: <em><span class="required">required</span>(one of voter, leader, follower, learner)</em></li><li><strong>count</strong>: <em><span class="required">required</span>(integer - minimum: 1)</em></li><li><strong>label_constraints</strong>: <em><span class="required">required</span>(array of LabelConstraint)</em><p><strong>Items</strong>: LabelConstraint</p><div class="items"><ul><li><strong>key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>op</strong>: <em><span class="required">required</span>(one of in, notIn, exists, notExists)</em></li><li><strong>values</strong>: <em>(array of string)</em></li></ul></div></li><li><strong>location_labels</strong>: <em><span class="required">required</span>(array of string)</em></li></ul></div><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The key is not in hex format.</p><h2>HTTP status code <a href="http://httpstatus.es/412" target="_blank">412</a></h2><p>Placement rules feature is not enabled.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_config_rule__group___id_"><span class="parent">/config</span>/rule/{group}/{id}</a> <span class="methods"><a href="#config_rule__group___id__get"><span class="badge badge_get">get</span></a> <a href="#config_rule__group___id__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_config_rule__group___id_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A Placement Rule.</p></div><div class="list-group"><div onclick="window.location.href = '#config_rule__group___id__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get a single Placement Rule.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#config_rule__group___id__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Delete a Placement Rule.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_rule__group___id__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/config</span>/rule/{group}/{id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get a single Placement Rule.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_rule__group___id__get_request" data-toggle="tab">Request</a></li><li><a href="#config_rule__group___id__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_rule__group___id__get_request"><h3>URI Parameters</h3><ul><li><strong>group</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>id</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="config_rule__group___id__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>group_id</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>id</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>index</strong>: <em>(integer)</em></li><li><strong>override</strong>: <em>(boolean)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>role</strong>: <em><span class="required">required</span>(one of voter, leader, follower, learner)</em></li><li><strong>count</strong>: <em><span class="required">required</span>(integer - minimum: 1)</em></li><li><strong>label_constraints</strong>: <em><span class="required">required</span>(array of LabelConstraint)</em><p><strong>Items</strong>: LabelConstraint</p><div class="items"><ul><li><strong>key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>op</strong>: <em><span class="required">required</span>(one of in, notIn, exists, notExists)</em></li><li><strong>values</strong>: <em>(array of string)</em></li></ul></div></li><li><strong>location_labels</strong>: <em><span class="required">required</span>(array of string)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><p>The Rule is not found.</p><h2>HTTP status code <a href="http://httpstatus.es/412" target="_blank">412</a></h2><p>Placement rules feature is not enabled.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_rule__group___id__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/config</span>/rule/{group}/{id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete a Placement Rule.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_rule__group___id__delete_request" data-toggle="tab">Request</a></li><li><a href="#config_rule__group___id__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_rule__group___id__delete_request"><h3>URI Parameters</h3><ul><li><strong>group</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>id</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="config_rule__group___id__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The Rule is delete.</p><h2>HTTP status code <a href="http://httpstatus.es/412" target="_blank">412</a></h2><p>Placement rules feature is not enabled.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_config_rule"><span class="parent">/config</span>/rule</a> <span class="methods"><a href="#config_rule_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_config_rule" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A Placement Rule.</p></div><div class="list-group"><div onclick="window.location.href = '#config_rule_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Add or update a Placement rule.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="config_rule_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/config</span>/rule</h4></div><div class="modal-body"><div class="alert alert-info"><p>Add or update a Placement rule.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#config_rule_post_request" data-toggle="tab">Request</a></li><li><a href="#config_rule_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="config_rule_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>group_id</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>id</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>index</strong>: <em>(integer)</em></li><li><strong>override</strong>: <em>(boolean)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>role</strong>: <em><span class="required">required</span>(one of voter, leader, follower, learner)</em></li><li><strong>count</strong>: <em><span class="required">required</span>(integer - minimum: 1)</em></li><li><strong>label_constraints</strong>: <em><span class="required">required</span>(array of LabelConstraint)</em><p><strong>Items</strong>: LabelConstraint</p><div class="items"><ul><li><strong>key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>op</strong>: <em><span class="required">required</span>(one of in, notIn, exists, notExists)</em></li><li><strong>values</strong>: <em>(array of string)</em></li></ul></div></li><li><strong>location_labels</strong>: <em><span class="required">required</span>(array of string)</em></li></ul></div><div class="tab-pane" id="config_rule_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The rule is created or updated.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/412" target="_blank">412</a></h2><p>Placement rules feature is not enabled.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="stores" class="panel-title">/stores</h3></div><div class="panel-body"><div class="top-resource-description"><p>The stores in the cluster.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stores"><span class="parent"></span>/stores</a> <span class="methods"><a href="#stores_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_stores" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#stores_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get stores in the cluster.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stores_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/stores</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get stores in the cluster.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stores_get_request" data-toggle="tab">Request</a></li><li><a href="#stores_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stores_get_request"><h3>Query Parameters</h3><ul><li><strong>state</strong>: <em>(array of )</em><p>Specify accepted store states.</p></li></ul></div><div class="tab-pane" id="stores_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>stores</strong>: <em><span class="required">required</span>(array of Store)</em><p><strong>Items</strong>: Store</p><div class="items"><ul><li><strong>store</strong>: <em><span class="required">required</span>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>address</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>state</strong>: <em><span class="required">required</span>(one of 0, 1, 2)</em></li><li><strong>state_name</strong>: <em><span class="required">required</span>(one of Up, Disconnected, Down, Offline, Tombstone)</em></li><li><strong>labels</strong>: <em>(array of StoreLabel)</em><p><strong>Items</strong>: StoreLabel</p><div class="items"><ul><li><strong>key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>value</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></li><li><strong>version</strong>: <em>(string)</em></li><li><strong>peer_address</strong>: <em><span class="required">required</span>(string)</em></li></ul></li><li><strong>status</strong>: <em><span class="required">required</span>(object)</em><ul><li><strong>capacity</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>available</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>used_size</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>leader_count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>leader_weight</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>leader_score</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>leader_size</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>region_count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>region_weight</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>region_score</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>region_size</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>sending_snap_count</strong>: <em>(integer)</em></li><li><strong>receiving_snap_count</strong>: <em>(integer)</em></li><li><strong>applying_snap_count</strong>: <em>(integer)</em></li><li><strong>is_busy</strong>: <em>(boolean)</em></li><li><strong>start_ts</strong>: <em>(string)</em></li><li><strong>last_heartbeat_ts</strong>: <em>(string)</em></li><li><strong>uptime</strong>: <em>(string)</em></li></ul></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stores_limit_scene"><span class="parent">/stores</span>/limit/scene</a> <span class="methods"><a href="#stores_limit_scene_get"><span class="badge badge_get">get</span></a> <a href="#stores_limit_scene_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_stores_limit_scene" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Get or update the store limit for scenes</p></div><div class="list-group"><div onclick="window.location.href = '#stores_limit_scene_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the store limit for scenes</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#stores_limit_scene_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Update the store limit for scenes</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stores_limit_scene_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/stores</span>/limit/scene</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the store limit for scenes</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stores_limit_scene_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stores_limit_scene_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>idle</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>low</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>normal</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>high</strong>: <em><span class="required">required</span>(integer)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="stores_limit_scene_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/stores</span>/limit/scene</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update the store limit for scenes</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stores_limit_scene_post_request" data-toggle="tab">Request</a></li><li><a href="#stores_limit_scene_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stores_limit_scene_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Media type</strong>: type</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>idle</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>low</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>normal</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>high</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div><div class="tab-pane" id="stores_limit_scene_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Store limit for specific scenes are updated</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stores_limit"><span class="parent">/stores</span>/limit</a> <span class="methods"><a href="#stores_limit_get"><span class="badge badge_get">get</span></a> <a href="#stores_limit_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_stores_limit" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>The balance rate limit for all stores.</p></div><div class="list-group"><div onclick="window.location.href = '#stores_limit_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get all stores&#39; balance rate limit.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#stores_limit_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Set all stores&#39; balance rate limit.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stores_limit_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/stores</span>/limit</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get all stores&#39; balance rate limit.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stores_limit_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stores_limit_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="stores_limit_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/stores</span>/limit</h4></div><div class="modal-body"><div class="alert alert-info"><p>Set all stores&#39; balance rate limit.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stores_limit_post_request" data-toggle="tab">Request</a></li><li><a href="#stores_limit_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stores_limit_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="stores_limit_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>All stores&#39; balance rate limits are updated.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stores_remove_tombstone"><span class="parent">/stores</span>/remove-tombstone</a> <span class="methods"><a href="#stores_remove_tombstone_delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_stores_remove_tombstone" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Remove all tombstone stores.</p></div><div class="list-group"><div onclick="window.location.href = '#stores_remove_tombstone_delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Remove all tombstone stores.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stores_remove_tombstone_delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/stores</span>/remove-tombstone</h4></div><div class="modal-body"><div class="alert alert-info"><p>Remove all tombstone stores.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stores_remove_tombstone_delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stores_remove_tombstone_delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>All tombstone stores are removed.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="store__storeid_" class="panel-title">/store/{storeId}</h3></div><div class="panel-body"><div class="top-resource-description"><p>A specific store.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_store__storeid_"><span class="parent"></span>/store/{storeId}</a> <span class="methods"><a href="#store__storeid__get"><span class="badge badge_get">get</span></a> <a href="#store__storeid__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_store__storeid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#store__storeid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get a store&#39;s information.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#store__storeid__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Take down a store from the cluster.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="store__storeid__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/store/{storeId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get a store&#39;s information.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#store__storeid__get_request" data-toggle="tab">Request</a></li><li><a href="#store__storeid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="store__storeid__get_request"><h3>URI Parameters</h3><ul><li><strong>storeId</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div><div class="tab-pane" id="store__storeid__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>store</strong>: <em><span class="required">required</span>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>address</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>state</strong>: <em><span class="required">required</span>(one of 0, 1, 2)</em></li><li><strong>state_name</strong>: <em><span class="required">required</span>(one of Up, Disconnected, Down, Offline, Tombstone)</em></li><li><strong>labels</strong>: <em>(array of StoreLabel)</em><p><strong>Items</strong>: StoreLabel</p><div class="items"><ul><li><strong>key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>value</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></li><li><strong>version</strong>: <em>(string)</em></li><li><strong>peer_address</strong>: <em><span class="required">required</span>(string)</em></li></ul></li><li><strong>status</strong>: <em><span class="required">required</span>(object)</em><ul><li><strong>capacity</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>available</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>used_size</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>leader_count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>leader_weight</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>leader_score</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>leader_size</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>region_count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>region_weight</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>region_score</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>region_size</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>sending_snap_count</strong>: <em>(integer)</em></li><li><strong>receiving_snap_count</strong>: <em>(integer)</em></li><li><strong>applying_snap_count</strong>: <em>(integer)</em></li><li><strong>is_busy</strong>: <em>(boolean)</em></li><li><strong>start_ts</strong>: <em>(string)</em></li><li><strong>last_heartbeat_ts</strong>: <em>(string)</em></li><li><strong>uptime</strong>: <em>(string)</em></li></ul></li></ul><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="store__storeid__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent"></span>/store/{storeId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Take down a store from the cluster.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#store__storeid__delete_request" data-toggle="tab">Request</a></li><li><a href="#store__storeid__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="store__storeid__delete_request"><h3>URI Parameters</h3><ul><li><strong>storeId</strong>: <em><span class="required">required</span>(integer)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>force</strong>: <em>(string)</em><p>Set status to Tombstone directly.</p></li></ul></div><div class="tab-pane" id="store__storeid__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The store is set as Offline or Tombstone.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><p>The store does not exist.</p><h2>HTTP status code <a href="http://httpstatus.es/410" target="_blank">410</a></h2><p>The store has already been removed.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_store__storeid__state"><span class="parent">/store/{storeId}</span>/state</a> <span class="methods"><a href="#store__storeid__state_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_store__storeid__state" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>The state for the specific store.</p></div><div class="list-group"><div onclick="window.location.href = '#store__storeid__state_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Set the store&#39;s state.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="store__storeid__state_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/store/{storeId}</span>/state</h4></div><div class="modal-body"><div class="alert alert-info"><p>Set the store&#39;s state.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#store__storeid__state_post_request" data-toggle="tab">Request</a></li><li><a href="#store__storeid__state_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="store__storeid__state_post_request"><h3>URI Parameters</h3><ul><li><strong>storeId</strong>: <em><span class="required">required</span>(integer)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>state</strong>: <em><span class="required">required</span>(one of Up, Offline, Tombstone)</em></li></ul></div><div class="tab-pane" id="store__storeid__state_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The store&#39;s state is updated.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><p>The store does not exist.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_store__storeid__label"><span class="parent">/store/{storeId}</span>/label</a> <span class="methods"><a href="#store__storeid__label_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_store__storeid__label" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>The label for the specific store.</p></div><div class="list-group"><div onclick="window.location.href = '#store__storeid__label_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Set the store&#39;s label.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="store__storeid__label_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/store/{storeId}</span>/label</h4></div><div class="modal-body"><div class="alert alert-info"><p>Set the store&#39;s label.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#store__storeid__label_post_request" data-toggle="tab">Request</a></li><li><a href="#store__storeid__label_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="store__storeid__label_post_request"><h3>URI Parameters</h3><ul><li><strong>storeId</strong>: <em><span class="required">required</span>(integer)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="store__storeid__label_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The store&#39;s label is updated.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_store__storeid__weight"><span class="parent">/store/{storeId}</span>/weight</a> <span class="methods"><a href="#store__storeid__weight_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_store__storeid__weight" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>The weight for the specific store.</p></div><div class="list-group"><div onclick="window.location.href = '#store__storeid__weight_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Set the store&#39;s leader/region weight.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="store__storeid__weight_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/store/{storeId}</span>/weight</h4></div><div class="modal-body"><div class="alert alert-info"><p>Set the store&#39;s leader/region weight.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#store__storeid__weight_post_request" data-toggle="tab">Request</a></li><li><a href="#store__storeid__weight_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="store__storeid__weight_post_request"><h3>URI Parameters</h3><ul><li><strong>storeId</strong>: <em><span class="required">required</span>(integer)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="store__storeid__weight_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The store&#39;s weight is updated.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_store__storeid__limit"><span class="parent">/store/{storeId}</span>/limit</a> <span class="methods"><a href="#store__storeid__limit_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_store__storeid__limit" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>The balance rate limit for the specific store.</p></div><div class="list-group"><div onclick="window.location.href = '#store__storeid__limit_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Set the store&#39;s balance rate limit.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="store__storeid__limit_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/store/{storeId}</span>/limit</h4></div><div class="modal-body"><div class="alert alert-info"><p>Set the store&#39;s balance rate limit.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#store__storeid__limit_post_request" data-toggle="tab">Request</a></li><li><a href="#store__storeid__limit_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="store__storeid__limit_post_request"><h3>URI Parameters</h3><ul><li><strong>storeId</strong>: <em><span class="required">required</span>(integer)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="store__storeid__limit_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The store&#39;s balance rate limit is updated.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="labels" class="panel-title">/labels</h3></div><div class="panel-body"><div class="top-resource-description"><p>The store label values in the cluster.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_labels"><span class="parent"></span>/labels</a> <span class="methods"><a href="#labels_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_labels" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#labels_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List all label values.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="labels_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/labels</h4></div><div class="modal-body"><div class="alert alert-info"><p>List all label values.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#labels_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="labels_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of object</p><p><strong>Items</strong>: StoreLabel</p><div class="items"><ul><li><strong>key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>value</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_labels_stores"><span class="parent">/labels</span>/stores</a> <span class="methods"><a href="#labels_stores_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_labels_stores" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#labels_stores_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List stores that have specific label values.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="labels_stores_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/labels</span>/stores</h4></div><div class="modal-body"><div class="alert alert-info"><p>List stores that have specific label values.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#labels_stores_get_request" data-toggle="tab">Request</a></li><li><a href="#labels_stores_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="labels_stores_get_request"><h3>Query Parameters</h3><ul><li><strong>name</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>value</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="labels_stores_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of object</p><p><strong>Items</strong>: Store</p><div class="items"><ul><li><strong>store</strong>: <em><span class="required">required</span>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>address</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>state</strong>: <em><span class="required">required</span>(one of 0, 1, 2)</em></li><li><strong>state_name</strong>: <em><span class="required">required</span>(one of Up, Disconnected, Down, Offline, Tombstone)</em></li><li><strong>labels</strong>: <em>(array of StoreLabel)</em><p><strong>Items</strong>: StoreLabel</p><div class="items"><ul><li><strong>key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>value</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></li><li><strong>version</strong>: <em>(string)</em></li><li><strong>peer_address</strong>: <em><span class="required">required</span>(string)</em></li></ul></li><li><strong>status</strong>: <em><span class="required">required</span>(object)</em><ul><li><strong>capacity</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>available</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>used_size</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>leader_count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>leader_weight</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>leader_score</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>leader_size</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>region_count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>region_weight</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>region_score</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>region_size</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>sending_snap_count</strong>: <em>(integer)</em></li><li><strong>receiving_snap_count</strong>: <em>(integer)</em></li><li><strong>applying_snap_count</strong>: <em>(integer)</em></li><li><strong>is_busy</strong>: <em>(boolean)</em></li><li><strong>start_ts</strong>: <em>(string)</em></li><li><strong>last_heartbeat_ts</strong>: <em>(string)</em></li><li><strong>uptime</strong>: <em>(string)</em></li></ul></li></ul></div><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="region" class="panel-title">/region</h3></div><div class="panel-body"><div class="top-resource-description"><p>A specific region in the cluster.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_region_id__id_"><span class="parent">/region</span>/id/{id}</a> <span class="methods"><a href="#region_id__id__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_region_id__id_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#region_id__id__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Search for a region by region ID.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="region_id__id__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/region</span>/id/{id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Search for a region by region ID.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#region_id__id__get_request" data-toggle="tab">Request</a></li><li><a href="#region_id__id__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="region_id__id__get_request"><h3>URI Parameters</h3><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div><div class="tab-pane" id="region_id__id__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>epoch</strong>: <em>(object)</em><ul><li><strong>conf_ver</strong>: <em>(integer)</em></li><li><strong>version</strong>: <em>(integer)</em></li></ul></li><li><strong>peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_peers</strong>: <em>(array of PeerStats)</em><p><strong>Items</strong>: PeerStats</p><div class="items"><ul><li><strong>peer</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_seconds</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li><li><strong>pending_peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>written_bytes</strong>: <em>(integer)</em></li><li><strong>read_bytes</strong>: <em>(integer)</em></li><li><strong>approximate_size</strong>: <em>(integer)</em></li><li><strong>approximate_keys</strong>: <em>(integer)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_region_key__key_"><span class="parent">/region</span>/key/{key}</a> <span class="methods"><a href="#region_key__key__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_region_key__key_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#region_key__key__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Search for a region by a key.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="region_key__key__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/region</span>/key/{key}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Search for a region by a key.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#region_key__key__get_request" data-toggle="tab">Request</a></li><li><a href="#region_key__key__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="region_key__key__get_request"><h3>URI Parameters</h3><ul><li><strong>key</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="region_key__key__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>epoch</strong>: <em>(object)</em><ul><li><strong>conf_ver</strong>: <em>(integer)</em></li><li><strong>version</strong>: <em>(integer)</em></li></ul></li><li><strong>peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_peers</strong>: <em>(array of PeerStats)</em><p><strong>Items</strong>: PeerStats</p><div class="items"><ul><li><strong>peer</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_seconds</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li><li><strong>pending_peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>written_bytes</strong>: <em>(integer)</em></li><li><strong>read_bytes</strong>: <em>(integer)</em></li><li><strong>approximate_size</strong>: <em>(integer)</em></li><li><strong>approximate_keys</strong>: <em>(integer)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="regions" class="panel-title">/regions</h3></div><div class="panel-body"><div class="top-resource-description"><p>The regions in the cluster.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_regions"><span class="parent"></span>/regions</a> <span class="methods"><a href="#regions_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_regions" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#regions_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List all regions in the cluster.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="regions_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/regions</h4></div><div class="modal-body"><div class="alert alert-info"><p>List all regions in the cluster.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#regions_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="regions_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>regions</strong>: <em><span class="required">required</span>(array of Region)</em><p><strong>Items</strong>: Region</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>epoch</strong>: <em>(object)</em><ul><li><strong>conf_ver</strong>: <em>(integer)</em></li><li><strong>version</strong>: <em>(integer)</em></li></ul></li><li><strong>peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_peers</strong>: <em>(array of PeerStats)</em><p><strong>Items</strong>: PeerStats</p><div class="items"><ul><li><strong>peer</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_seconds</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li><li><strong>pending_peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>written_bytes</strong>: <em>(integer)</em></li><li><strong>read_bytes</strong>: <em>(integer)</em></li><li><strong>approximate_size</strong>: <em>(integer)</em></li><li><strong>approximate_keys</strong>: <em>(integer)</em></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_regions_count"><span class="parent">/regions</span>/count</a> <span class="methods"><a href="#regions_count_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_regions_count" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#regions_count_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get region count in the cluster.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="regions_count_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/regions</span>/count</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get region count in the cluster.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#regions_count_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="regions_count_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>regions</strong>: <em><span class="required">required</span>(array of Region)</em><p><strong>Items</strong>: Region</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>epoch</strong>: <em>(object)</em><ul><li><strong>conf_ver</strong>: <em>(integer)</em></li><li><strong>version</strong>: <em>(integer)</em></li></ul></li><li><strong>peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_peers</strong>: <em>(array of PeerStats)</em><p><strong>Items</strong>: PeerStats</p><div class="items"><ul><li><strong>peer</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_seconds</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li><li><strong>pending_peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>written_bytes</strong>: <em>(integer)</em></li><li><strong>read_bytes</strong>: <em>(integer)</em></li><li><strong>approximate_size</strong>: <em>(integer)</em></li><li><strong>approximate_keys</strong>: <em>(integer)</em></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_regions_writeflow"><span class="parent">/regions</span>/writeflow</a> <span class="methods"><a href="#regions_writeflow_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_regions_writeflow" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#regions_writeflow_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List regions with the highest write flow.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="regions_writeflow_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/regions</span>/writeflow</h4></div><div class="modal-body"><div class="alert alert-info"><p>List regions with the highest write flow.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#regions_writeflow_get_request" data-toggle="tab">Request</a></li><li><a href="#regions_writeflow_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="regions_writeflow_get_request"><h3>Query Parameters</h3><ul><li><strong>limit</strong>: <em>(integer - default: 16)</em></li></ul></div><div class="tab-pane" id="regions_writeflow_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>regions</strong>: <em><span class="required">required</span>(array of Region)</em><p><strong>Items</strong>: Region</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>epoch</strong>: <em>(object)</em><ul><li><strong>conf_ver</strong>: <em>(integer)</em></li><li><strong>version</strong>: <em>(integer)</em></li></ul></li><li><strong>peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_peers</strong>: <em>(array of PeerStats)</em><p><strong>Items</strong>: PeerStats</p><div class="items"><ul><li><strong>peer</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_seconds</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li><li><strong>pending_peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>written_bytes</strong>: <em>(integer)</em></li><li><strong>read_bytes</strong>: <em>(integer)</em></li><li><strong>approximate_size</strong>: <em>(integer)</em></li><li><strong>approximate_keys</strong>: <em>(integer)</em></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_regions_readflow"><span class="parent">/regions</span>/readflow</a> <span class="methods"><a href="#regions_readflow_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_regions_readflow" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#regions_readflow_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List regions with the highest read flow.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="regions_readflow_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/regions</span>/readflow</h4></div><div class="modal-body"><div class="alert alert-info"><p>List regions with the highest read flow.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#regions_readflow_get_request" data-toggle="tab">Request</a></li><li><a href="#regions_readflow_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="regions_readflow_get_request"><h3>Query Parameters</h3><ul><li><strong>limit</strong>: <em>(integer - default: 16)</em></li></ul></div><div class="tab-pane" id="regions_readflow_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>regions</strong>: <em><span class="required">required</span>(array of Region)</em><p><strong>Items</strong>: Region</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>epoch</strong>: <em>(object)</em><ul><li><strong>conf_ver</strong>: <em>(integer)</em></li><li><strong>version</strong>: <em>(integer)</em></li></ul></li><li><strong>peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_peers</strong>: <em>(array of PeerStats)</em><p><strong>Items</strong>: PeerStats</p><div class="items"><ul><li><strong>peer</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_seconds</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li><li><strong>pending_peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>written_bytes</strong>: <em>(integer)</em></li><li><strong>read_bytes</strong>: <em>(integer)</em></li><li><strong>approximate_size</strong>: <em>(integer)</em></li><li><strong>approximate_keys</strong>: <em>(integer)</em></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_regions_confver"><span class="parent">/regions</span>/confver</a> <span class="methods"><a href="#regions_confver_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_regions_confver" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#regions_confver_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List regions with the largest conf version.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="regions_confver_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/regions</span>/confver</h4></div><div class="modal-body"><div class="alert alert-info"><p>List regions with the largest conf version.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#regions_confver_get_request" data-toggle="tab">Request</a></li><li><a href="#regions_confver_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="regions_confver_get_request"><h3>Query Parameters</h3><ul><li><strong>limit</strong>: <em>(integer - default: 16)</em></li></ul></div><div class="tab-pane" id="regions_confver_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>regions</strong>: <em><span class="required">required</span>(array of Region)</em><p><strong>Items</strong>: Region</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>epoch</strong>: <em>(object)</em><ul><li><strong>conf_ver</strong>: <em>(integer)</em></li><li><strong>version</strong>: <em>(integer)</em></li></ul></li><li><strong>peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_peers</strong>: <em>(array of PeerStats)</em><p><strong>Items</strong>: PeerStats</p><div class="items"><ul><li><strong>peer</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_seconds</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li><li><strong>pending_peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>written_bytes</strong>: <em>(integer)</em></li><li><strong>read_bytes</strong>: <em>(integer)</em></li><li><strong>approximate_size</strong>: <em>(integer)</em></li><li><strong>approximate_keys</strong>: <em>(integer)</em></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_regions_version"><span class="parent">/regions</span>/version</a> <span class="methods"><a href="#regions_version_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_regions_version" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#regions_version_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List regions with the largest version.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="regions_version_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/regions</span>/version</h4></div><div class="modal-body"><div class="alert alert-info"><p>List regions with the largest version.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#regions_version_get_request" data-toggle="tab">Request</a></li><li><a href="#regions_version_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="regions_version_get_request"><h3>Query Parameters</h3><ul><li><strong>limit</strong>: <em>(integer - default: 16)</em></li></ul></div><div class="tab-pane" id="regions_version_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>regions</strong>: <em><span class="required">required</span>(array of Region)</em><p><strong>Items</strong>: Region</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>epoch</strong>: <em>(object)</em><ul><li><strong>conf_ver</strong>: <em>(integer)</em></li><li><strong>version</strong>: <em>(integer)</em></li></ul></li><li><strong>peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_peers</strong>: <em>(array of PeerStats)</em><p><strong>Items</strong>: PeerStats</p><div class="items"><ul><li><strong>peer</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_seconds</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li><li><strong>pending_peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>written_bytes</strong>: <em>(integer)</em></li><li><strong>read_bytes</strong>: <em>(integer)</em></li><li><strong>approximate_size</strong>: <em>(integer)</em></li><li><strong>approximate_keys</strong>: <em>(integer)</em></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_regions_size"><span class="parent">/regions</span>/size</a> <span class="methods"><a href="#regions_size_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_regions_size" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#regions_size_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List regions with the largest size.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="regions_size_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/regions</span>/size</h4></div><div class="modal-body"><div class="alert alert-info"><p>List regions with the largest size.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#regions_size_get_request" data-toggle="tab">Request</a></li><li><a href="#regions_size_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="regions_size_get_request"><h3>Query Parameters</h3><ul><li><strong>limit</strong>: <em>(integer - default: 16)</em></li></ul></div><div class="tab-pane" id="regions_size_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>regions</strong>: <em><span class="required">required</span>(array of Region)</em><p><strong>Items</strong>: Region</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>epoch</strong>: <em>(object)</em><ul><li><strong>conf_ver</strong>: <em>(integer)</em></li><li><strong>version</strong>: <em>(integer)</em></li></ul></li><li><strong>peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_peers</strong>: <em>(array of PeerStats)</em><p><strong>Items</strong>: PeerStats</p><div class="items"><ul><li><strong>peer</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_seconds</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li><li><strong>pending_peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>written_bytes</strong>: <em>(integer)</em></li><li><strong>read_bytes</strong>: <em>(integer)</em></li><li><strong>approximate_size</strong>: <em>(integer)</em></li><li><strong>approximate_keys</strong>: <em>(integer)</em></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_regions_key"><span class="parent">/regions</span>/key</a> <span class="methods"><a href="#regions_key_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_regions_key" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#regions_key_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List regions start from a key.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="regions_key_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/regions</span>/key</h4></div><div class="modal-body"><div class="alert alert-info"><p>List regions start from a key.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#regions_key_get_request" data-toggle="tab">Request</a></li><li><a href="#regions_key_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="regions_key_get_request"><h3>Query Parameters</h3><ul><li><strong>key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>limit</strong>: <em>(integer - default: 16)</em></li></ul></div><div class="tab-pane" id="regions_key_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>regions</strong>: <em><span class="required">required</span>(array of Region)</em><p><strong>Items</strong>: Region</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>epoch</strong>: <em>(object)</em><ul><li><strong>conf_ver</strong>: <em>(integer)</em></li><li><strong>version</strong>: <em>(integer)</em></li></ul></li><li><strong>peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_peers</strong>: <em>(array of PeerStats)</em><p><strong>Items</strong>: PeerStats</p><div class="items"><ul><li><strong>peer</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_seconds</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li><li><strong>pending_peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>written_bytes</strong>: <em>(integer)</em></li><li><strong>read_bytes</strong>: <em>(integer)</em></li><li><strong>approximate_size</strong>: <em>(integer)</em></li><li><strong>approximate_keys</strong>: <em>(integer)</em></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_regions_check__filter_"><span class="parent">/regions</span>/check/{filter}</a> <span class="methods"><a href="#regions_check__filter__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_regions_check__filter_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#regions_check__filter__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List regions with unhealthy status.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="regions_check__filter__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/regions</span>/check/{filter}</h4></div><div class="modal-body"><div class="alert alert-info"><p>List regions with unhealthy status.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#regions_check__filter__get_request" data-toggle="tab">Request</a></li><li><a href="#regions_check__filter__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="regions_check__filter__get_request"><h3>URI Parameters</h3><ul><li><strong>filter</strong>: <em><span class="required">required</span>(one of miss-peer, extra-peer, pending-peer, down-peer, offline-peer, empty-region, hist-size, hist-keys)</em></li></ul></div><div class="tab-pane" id="regions_check__filter__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>regions</strong>: <em><span class="required">required</span>(array of Region)</em><p><strong>Items</strong>: Region</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>epoch</strong>: <em>(object)</em><ul><li><strong>conf_ver</strong>: <em>(integer)</em></li><li><strong>version</strong>: <em>(integer)</em></li></ul></li><li><strong>peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_peers</strong>: <em>(array of PeerStats)</em><p><strong>Items</strong>: PeerStats</p><div class="items"><ul><li><strong>peer</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_seconds</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li><li><strong>pending_peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>written_bytes</strong>: <em>(integer)</em></li><li><strong>read_bytes</strong>: <em>(integer)</em></li><li><strong>approximate_size</strong>: <em>(integer)</em></li><li><strong>approximate_keys</strong>: <em>(integer)</em></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_regions_sibling__id_"><span class="parent">/regions</span>/sibling/{id}</a> <span class="methods"><a href="#regions_sibling__id__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_regions_sibling__id_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#regions_sibling__id__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List sibling regions of a specific region.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="regions_sibling__id__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/regions</span>/sibling/{id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>List sibling regions of a specific region.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#regions_sibling__id__get_request" data-toggle="tab">Request</a></li><li><a href="#regions_sibling__id__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="regions_sibling__id__get_request"><h3>URI Parameters</h3><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div><div class="tab-pane" id="regions_sibling__id__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>regions</strong>: <em><span class="required">required</span>(array of Region)</em><p><strong>Items</strong>: Region</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>epoch</strong>: <em>(object)</em><ul><li><strong>conf_ver</strong>: <em>(integer)</em></li><li><strong>version</strong>: <em>(integer)</em></li></ul></li><li><strong>peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_peers</strong>: <em>(array of PeerStats)</em><p><strong>Items</strong>: PeerStats</p><div class="items"><ul><li><strong>peer</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_seconds</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li><li><strong>pending_peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>written_bytes</strong>: <em>(integer)</em></li><li><strong>read_bytes</strong>: <em>(integer)</em></li><li><strong>approximate_size</strong>: <em>(integer)</em></li><li><strong>approximate_keys</strong>: <em>(integer)</em></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><p>The region does not exist.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_regions_store__id_"><span class="parent">/regions</span>/store/{id}</a> <span class="methods"><a href="#regions_store__id__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_regions_store__id_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#regions_store__id__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List all regions of a specific store.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="regions_store__id__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/regions</span>/store/{id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>List all regions of a specific store.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#regions_store__id__get_request" data-toggle="tab">Request</a></li><li><a href="#regions_store__id__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="regions_store__id__get_request"><h3>URI Parameters</h3><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div><div class="tab-pane" id="regions_store__id__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>regions</strong>: <em><span class="required">required</span>(array of Region)</em><p><strong>Items</strong>: Region</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>end_key</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>epoch</strong>: <em>(object)</em><ul><li><strong>conf_ver</strong>: <em>(integer)</em></li><li><strong>version</strong>: <em>(integer)</em></li></ul></li><li><strong>peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>leader</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_peers</strong>: <em>(array of PeerStats)</em><p><strong>Items</strong>: PeerStats</p><div class="items"><ul><li><strong>peer</strong>: <em>(object)</em><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></li><li><strong>down_seconds</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li><li><strong>pending_peers</strong>: <em>(array of Peer)</em><p><strong>Items</strong>: Peer</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>is_learner</strong>: <em>(boolean)</em></li></ul></div></li><li><strong>written_bytes</strong>: <em>(integer)</em></li><li><strong>read_bytes</strong>: <em>(integer)</em></li><li><strong>approximate_size</strong>: <em>(integer)</em></li><li><strong>approximate_keys</strong>: <em>(integer)</em></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="schedulers" class="panel-title">/schedulers</h3></div><div class="panel-body"><div class="top-resource-description"><p>Running schedulers.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_schedulers"><span class="parent"></span>/schedulers</a> <span class="methods"><a href="#schedulers_get"><span class="badge badge_get">get</span></a> <a href="#schedulers_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_schedulers" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#schedulers_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List running schedulers.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#schedulers_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create a scheduler.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="schedulers_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/schedulers</h4></div><div class="modal-body"><div class="alert alert-info"><p>List running schedulers.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#schedulers_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="schedulers_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of string</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="schedulers_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/schedulers</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create a scheduler.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#schedulers_post_request" data-toggle="tab">Request</a></li><li><a href="#schedulers_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="schedulers_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>name</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="schedulers_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The scheduler is created.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>Bad format request.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_schedulers__name_"><span class="parent">/schedulers</span>/{name}</a> <span class="methods"><a href="#schedulers__name__delete"><span class="badge badge_delete">delete</span></a> <a href="#schedulers__name__post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_schedulers__name_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A specific scheduler or all schedulers.</p></div><div class="list-group"><div onclick="window.location.href = '#schedulers__name__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Delete a scheduler.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#schedulers__name__post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Pause or resume a specific scheduler or all schedulers.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="schedulers__name__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/schedulers</span>/{name}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete a scheduler.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#schedulers__name__delete_request" data-toggle="tab">Request</a></li><li><a href="#schedulers__name__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="schedulers__name__delete_request"><h3>URI Parameters</h3><ul><li><strong>name</strong>: <em><span class="required">required</span>(string)</em><p>The name of a specific scheduler or "all" means all shcedulers.</p></li></ul></div><div class="tab-pane" id="schedulers__name__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The scheduler is removed.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="schedulers__name__post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/schedulers</span>/{name}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Pause or resume a specific scheduler or all schedulers.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#schedulers__name__post_request" data-toggle="tab">Request</a></li><li><a href="#schedulers__name__post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="schedulers__name__post_request"><h3>URI Parameters</h3><ul><li><strong>name</strong>: <em><span class="required">required</span>(string)</em><p>The name of a specific scheduler or "all" means all shcedulers.</p></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>delay</strong>: <em><span class="required">required</span>(integer)</em><p>how long does the specified shcedulers pause.</p></li></ul></div><div class="tab-pane" id="schedulers__name__post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>pause specified schedulers for some time or resume specified schedulers.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="operators" class="panel-title">/operators</h3></div><div class="panel-body"><div class="top-resource-description"><p>Pending operators.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_operators"><span class="parent"></span>/operators</a> <span class="methods"><a href="#operators_get"><span class="badge badge_get">get</span></a> <a href="#operators_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_operators" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#operators_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List pending operators.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#operators_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create an operator.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="operators_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/operators</h4></div><div class="modal-body"><div class="alert alert-info"><p>List pending operators.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#operators_get_request" data-toggle="tab">Request</a></li><li><a href="#operators_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="operators_get_request"><h3>Query Parameters</h3><ul><li><strong>kind</strong>: <em>(one of admin, leader, region)</em><p>Specify the operator kind.</p></li></ul></div><div class="tab-pane" id="operators_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of string</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="operators_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/operators</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create an operator.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#operators_post_request" data-toggle="tab">Request</a></li><li><a href="#operators_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="operators_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>name</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="operators_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The operator is created.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_operators__regionid_"><span class="parent">/operators</span>/{regionId}</a> <span class="methods"><a href="#operators__regionid__get"><span class="badge badge_get">get</span></a> <a href="#operators__regionid__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_operators__regionid_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A specific Region&#39;s pending operator.</p></div><div class="list-group"><div onclick="window.location.href = '#operators__regionid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get a Region&#39;s pending operator.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#operators__regionid__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Cancel a Region&#39;s pending operator.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="operators__regionid__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/operators</span>/{regionId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get a Region&#39;s pending operator.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#operators__regionid__get_request" data-toggle="tab">Request</a></li><li><a href="#operators__regionid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="operators__regionid__get_request"><h3>URI Parameters</h3><ul><li><strong>regionId</strong>: <em><span class="required">required</span>(integer)</em><p>A Region&#39;s Id.</p></li></ul></div><div class="tab-pane" id="operators__regionid__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: string</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="operators__regionid__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/operators</span>/{regionId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Cancel a Region&#39;s pending operator.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#operators__regionid__delete_request" data-toggle="tab">Request</a></li><li><a href="#operators__regionid__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="operators__regionid__delete_request"><h3>URI Parameters</h3><ul><li><strong>regionId</strong>: <em><span class="required">required</span>(integer)</em><p>A Region&#39;s Id.</p></li></ul></div><div class="tab-pane" id="operators__regionid__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The pending operator is cancelled.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="hotspot" class="panel-title">/hotspot</h3></div><div class="panel-body"><div class="top-resource-description"><p>The hot spots status in the cluster.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_hotspot_regions_write"><span class="parent">/hotspot</span>/regions/write</a> <span class="methods"><a href="#hotspot_regions_write_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_hotspot_regions_write" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#hotspot_regions_write_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List the hot write regions.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="hotspot_regions_write_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/hotspot</span>/regions/write</h4></div><div class="modal-body"><div class="alert alert-info"><p>List the hot write regions.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#hotspot_regions_write_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="hotspot_regions_write_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>as_peer</strong>: <em><span class="required">required</span>(object)</em><ul></ul></li><li><strong>as_leadr</strong>: <em><span class="required">required</span>(object)</em><ul></ul></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_hotspot_regions_read"><span class="parent">/hotspot</span>/regions/read</a> <span class="methods"><a href="#hotspot_regions_read_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_hotspot_regions_read" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#hotspot_regions_read_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List the hot read regions.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="hotspot_regions_read_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/hotspot</span>/regions/read</h4></div><div class="modal-body"><div class="alert alert-info"><p>List the hot read regions.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#hotspot_regions_read_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="hotspot_regions_read_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>as_peer</strong>: <em><span class="required">required</span>(object)</em><ul></ul></li><li><strong>as_leadr</strong>: <em><span class="required">required</span>(object)</em><ul></ul></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_hotspot_stores"><span class="parent">/hotspot</span>/stores</a> <span class="methods"><a href="#hotspot_stores_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_hotspot_stores" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#hotspot_stores_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List the hot stores.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="hotspot_stores_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/hotspot</span>/stores</h4></div><div class="modal-body"><div class="alert alert-info"><p>List the hot stores.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#hotspot_stores_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="hotspot_stores_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>bytes-write-rate</strong>: <em>(object)</em><ul></ul></li><li><strong>bytes-read-rate</strong>: <em>(object)</em><ul></ul></li><li><strong>keys-write-rate</strong>: <em>(object)</em><ul></ul></li><li><strong>keys-read-rate</strong>: <em>(object)</em><ul></ul></li></ul></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="stats" class="panel-title">/stats</h3></div><div class="panel-body"><div class="top-resource-description"><p>Statistics of the cluster.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stats_region"><span class="parent">/stats</span>/region</a> <span class="methods"><a href="#stats_region_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_stats_region" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#stats_region_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get region statistics of a specified range.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stats_region_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/stats</span>/region</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get region statistics of a specified range.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stats_region_get_request" data-toggle="tab">Request</a></li><li><a href="#stats_region_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stats_region_get_request"><h3>Query Parameters</h3><ul><li><strong>start_key</strong>: <em>(string)</em></li><li><strong>end_key</strong>: <em>(string)</em></li></ul></div><div class="tab-pane" id="stats_region_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>empty_count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>storage_size</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>storage_keys</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>store_leader_count</strong>: <em><span class="required">required</span>(object)</em><ul></ul></li><li><strong>store_peer_count</strong>: <em><span class="required">required</span>(object)</em><ul></ul></li><li><strong>store_leader_size</strong>: <em><span class="required">required</span>(object)</em><ul></ul></li><li><strong>store_leader_keys</strong>: <em><span class="required">required</span>(object)</em><ul></ul></li><li><strong>store_peer_size</strong>: <em><span class="required">required</span>(object)</em><ul></ul></li><li><strong>store_peer_keys</strong>: <em><span class="required">required</span>(object)</em><ul></ul></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="trend" class="panel-title">/trend</h3></div><div class="panel-body"><div class="top-resource-description"><p>Trend of data growth and movements.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_trend"><span class="parent"></span>/trend</a> <span class="methods"><a href="#trend_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_trend" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#trend_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the growth and changes of data in the most recent period of time.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="trend_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/trend</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the growth and changes of data in the most recent period of time.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#trend_get_request" data-toggle="tab">Request</a></li><li><a href="#trend_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="trend_get_request"><h3>Query Parameters</h3><ul><li><strong>from</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div><div class="tab-pane" id="trend_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>stores</strong>: <em><span class="required">required</span>(array of TrendStore)</em><p><strong>Items</strong>: TrendStore</p><div class="items"><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>address</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>state_name</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>capacity</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>available</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>region_count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>leader_count</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>start_ts</strong>: <em>(string)</em></li><li><strong>last_heartbeat_ts</strong>: <em>(string)</em></li><li><strong>uptime</strong>: <em>(string)</em></li><li><strong>hot_write_flow</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>hot_write_region_flows</strong>: <em><span class="required">required</span>(array of number)</em></li><li><strong>hot_read_flow</strong>: <em><span class="required">required</span>(number)</em></li><li><strong>hot_read_region_flows</strong>: <em><span class="required">required</span>(array of number)</em></li></ul></div></li><li><strong>history</strong>: <em><span class="required">required</span>(object)</em><ul><li><strong>start</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>end</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>entries</strong>: <em><span class="required">required</span>(array of TrendHistoryEntry)</em><p><strong>Items</strong>: TrendHistoryEntry</p><div class="items"><ul><li><strong>from</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>to</strong>: <em><span class="required">required</span>(integer)</em></li><li><strong>kind</strong>: <em><span class="required">required</span>(one of leader, region)</em></li><li><strong>count</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div></li></ul></li></ul><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The request is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="admin" class="panel-title">/admin</h3></div><div class="panel-body"><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_admin_cache_region__id_"><span class="parent">/admin</span>/cache/region/{id}</a> <span class="methods"><a href="#admin_cache_region__id__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_admin_cache_region__id_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#admin_cache_region__id__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Drop a specific region from cache.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="admin_cache_region__id__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/admin</span>/cache/region/{id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Drop a specific region from cache.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#admin_cache_region__id__delete_request" data-toggle="tab">Request</a></li><li><a href="#admin_cache_region__id__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="admin_cache_region__id__delete_request"><h3>URI Parameters</h3><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em></li></ul></div><div class="tab-pane" id="admin_cache_region__id__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The region is removed from server cache.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_admin_log"><span class="parent">/admin</span>/log</a> <span class="methods"><a href="#admin_log_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_admin_log" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>The log level of PD server.</p></div><div class="list-group"><div onclick="window.location.href = '#admin_log_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Set log level.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="admin_log_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/admin</span>/log</h4></div><div class="modal-body"><div class="alert alert-info"><p>Set log level.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#admin_log_post_request" data-toggle="tab">Request</a></li><li><a href="#admin_log_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="admin_log_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: string</p></div><div class="tab-pane" id="admin_log_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The log level is updated.</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><p>The input is invalid.</p><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="metric" class="panel-title">/metric</h3></div><div class="panel-body"><div class="top-resource-description"><p>Query metric.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_metric_query"><span class="parent">/metric</span>/query</a> <span class="methods"><a href="#metric_query_get"><span class="badge badge_get">get</span></a> <a href="#metric_query_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_metric_query" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#metric_query_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Query instant metric api.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#metric_query_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Query instant metric api.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="metric_query_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/metric</span>/query</h4></div><div class="modal-body"><div class="alert alert-info"><p>Query instant metric api.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#metric_query_get_request" data-toggle="tab">Request</a></li><li><a href="#metric_query_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="metric_query_get_request"><h3>Query Parameters</h3><ul><li><strong>query</strong>: <em><span class="required">required</span>(string)</em><p>promQL query statement.</p></li><li><strong>time</strong>: <em>(string)</em><p>Evaluation timestamp, such as 2019-11-22T20:10:51.781Z.</p></li><li><strong>timeout</strong>: <em>(string)</em><p>Evaluation timeout, such as 15s.</p></li></ul></div><div class="tab-pane" id="metric_query_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>data</strong>: <em><span class="required">required</span>(Metric data)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="metric_query_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/metric</span>/query</h4></div><div class="modal-body"><div class="alert alert-info"><p>Query instant metric api.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#metric_query_post_request" data-toggle="tab">Request</a></li><li><a href="#metric_query_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="metric_query_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>query</strong>: <em><span class="required">required</span>(string)</em><p>promQL query statement.</p></li><li><strong>time</strong>: <em>(string)</em><p>Evaluation timestamp, such as 2019-11-22T20:10:51.781Z.</p></li><li><strong>timeout</strong>: <em>(string)</em><p>Evaluation timeout, such as 15s.</p></li></ul></div><div class="tab-pane" id="metric_query_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>data</strong>: <em><span class="required">required</span>(Metric data)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_metric_query_range"><span class="parent">/metric</span>/query_range</a> <span class="methods"><a href="#metric_query_range_get"><span class="badge badge_get">get</span></a> <a href="#metric_query_range_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_metric_query_range" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#metric_query_range_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Query range metric api.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#metric_query_range_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Query range metric api.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="metric_query_range_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/metric</span>/query_range</h4></div><div class="modal-body"><div class="alert alert-info"><p>Query range metric api.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#metric_query_range_get_request" data-toggle="tab">Request</a></li><li><a href="#metric_query_range_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="metric_query_range_get_request"><h3>Query Parameters</h3><ul><li><strong>query</strong>: <em><span class="required">required</span>(string)</em><p>promQL query statement.</p></li><li><strong>start</strong>: <em><span class="required">required</span>(string)</em><p>Evaluation start timestamp, such as 2019-11-22T20:10:51.781Z.</p></li><li><strong>end</strong>: <em><span class="required">required</span>(string)</em><p>Evaluation end timestamp, such as 2019-11-22T20:10:51.781Z.</p></li><li><strong>timeout</strong>: <em>(string)</em><p>Evaluation timeout, such as 15s.</p></li></ul></div><div class="tab-pane" id="metric_query_range_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>data</strong>: <em><span class="required">required</span>(Metric data)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="metric_query_range_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/metric</span>/query_range</h4></div><div class="modal-body"><div class="alert alert-info"><p>Query range metric api.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#metric_query_range_post_request" data-toggle="tab">Request</a></li><li><a href="#metric_query_range_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="metric_query_range_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>query</strong>: <em><span class="required">required</span>(string)</em><p>promQL query statement.</p></li><li><strong>start</strong>: <em><span class="required">required</span>(string)</em><p>Evaluation start timestamp, such as 2019-11-22T20:10:51.781Z.</p></li><li><strong>end</strong>: <em><span class="required">required</span>(string)</em><p>Evaluation end timestamp, such as 2019-11-22T20:10:51.781Z.</p></li><li><strong>timeout</strong>: <em>(string)</em><p>Evaluation timeout, such as 15s.</p></li></ul></div><div class="tab-pane" id="metric_query_range_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>data</strong>: <em><span class="required">required</span>(Metric data)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>PD server failed to proceed the request.</p></div></div></div></div></div></div></div></div></div></div></div><div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked"><li><a href="#cluster_status">/cluster/status</a></li><li><a href="#version">/version</a></li><li><a href="#status">/status</a></li><li><a href="#diagnose">/diagnose</a></li><li><a href="#members">/members</a></li><li><a href="#leader">/leader</a></li><li><a href="#health">/health</a></li><li><a href="#ping">/ping</a></li><li><a href="#config">/config</a></li><li><a href="#stores">/stores</a></li><li><a href="#store__storeid_">/store/{storeId}</a></li><li><a href="#labels">/labels</a></li><li><a href="#region">/region</a></li><li><a href="#regions">/regions</a></li><li><a href="#schedulers">/schedulers</a></li><li><a href="#operators">/operators</a></li><li><a href="#hotspot">/hotspot</a></li><li><a href="#stats">/stats</a></li><li><a href="#trend">/trend</a></li><li><a href="#admin">/admin</a></li><li><a href="#metric">/metric</a></li></ul></div></div></div></div></body></html>